home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / email / charset.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  13KB  |  359 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. __all__ = [
  5.     'Charset',
  6.     'add_alias',
  7.     'add_charset',
  8.     'add_codec']
  9. import email.base64mime as email
  10. import email.quoprimime as email
  11. from email import errors
  12. from email.encoders import encode_7or8bit
  13. QP = 1
  14. BASE64 = 2
  15. SHORTEST = 3
  16. MISC_LEN = 7
  17. DEFAULT_CHARSET = 'us-ascii'
  18. CHARSETS = {
  19.     'iso-8859-1': (QP, QP, None),
  20.     'iso-8859-2': (QP, QP, None),
  21.     'iso-8859-3': (QP, QP, None),
  22.     'iso-8859-4': (QP, QP, None),
  23.     'iso-8859-9': (QP, QP, None),
  24.     'iso-8859-10': (QP, QP, None),
  25.     'iso-8859-13': (QP, QP, None),
  26.     'iso-8859-14': (QP, QP, None),
  27.     'iso-8859-15': (QP, QP, None),
  28.     'windows-1252': (QP, QP, None),
  29.     'viscii': (QP, QP, None),
  30.     'us-ascii': (None, None, None),
  31.     'big5': (BASE64, BASE64, None),
  32.     'gb2312': (BASE64, BASE64, None),
  33.     'euc-jp': (BASE64, None, 'iso-2022-jp'),
  34.     'shift_jis': (BASE64, None, 'iso-2022-jp'),
  35.     'iso-2022-jp': (BASE64, None, None),
  36.     'koi8-r': (BASE64, BASE64, None),
  37.     'utf-8': (SHORTEST, BASE64, 'utf-8'),
  38.     '8bit': (None, BASE64, 'utf-8') }
  39. ALIASES = {
  40.     'latin_1': 'iso-8859-1',
  41.     'latin-1': 'iso-8859-1',
  42.     'latin_2': 'iso-8859-2',
  43.     'latin-2': 'iso-8859-2',
  44.     'latin_3': 'iso-8859-3',
  45.     'latin-3': 'iso-8859-3',
  46.     'latin_4': 'iso-8859-4',
  47.     'latin-4': 'iso-8859-4',
  48.     'latin_5': 'iso-8859-9',
  49.     'latin-5': 'iso-8859-9',
  50.     'latin_6': 'iso-8859-10',
  51.     'latin-6': 'iso-8859-10',
  52.     'latin_7': 'iso-8859-13',
  53.     'latin-7': 'iso-8859-13',
  54.     'latin_8': 'iso-8859-14',
  55.     'latin-8': 'iso-8859-14',
  56.     'latin_9': 'iso-8859-15',
  57.     'latin-9': 'iso-8859-15',
  58.     'cp949': 'ks_c_5601-1987',
  59.     'euc_jp': 'euc-jp',
  60.     'euc_kr': 'euc-kr',
  61.     'ascii': 'us-ascii' }
  62. CODEC_MAP = {
  63.     'gb2312': 'eucgb2312_cn',
  64.     'big5': 'big5_tw',
  65.     'us-ascii': None }
  66.  
  67. def add_charset(charset, header_enc = None, body_enc = None, output_charset = None):
  68.     """Add character set properties to the global registry.
  69.  
  70.     charset is the input character set, and must be the canonical name of a
  71.     character set.
  72.  
  73.     Optional header_enc and body_enc is either Charset.QP for
  74.     quoted-printable, Charset.BASE64 for base64 encoding, Charset.SHORTEST for
  75.     the shortest of qp or base64 encoding, or None for no encoding.  SHORTEST
  76.     is only valid for header_enc.  It describes how message headers and
  77.     message bodies in the input charset are to be encoded.  Default is no
  78.     encoding.
  79.  
  80.     Optional output_charset is the character set that the output should be
  81.     in.  Conversions will proceed from input charset, to Unicode, to the
  82.     output charset when the method Charset.convert() is called.  The default
  83.     is to output in the same character set as the input.
  84.  
  85.     Both input_charset and output_charset must have Unicode codec entries in
  86.     the module's charset-to-codec mapping; use add_codec(charset, codecname)
  87.     to add codecs the module does not know about.  See the codecs module's
  88.     documentation for more information.
  89.     """
  90.     if body_enc == SHORTEST:
  91.         raise ValueError('SHORTEST not allowed for body_enc')
  92.     
  93.     CHARSETS[charset] = (header_enc, body_enc, output_charset)
  94.  
  95.  
  96. def add_alias(alias, canonical):
  97.     """Add a character set alias.
  98.  
  99.     alias is the alias name, e.g. latin-1
  100.     canonical is the character set's canonical name, e.g. iso-8859-1
  101.     """
  102.     ALIASES[alias] = canonical
  103.  
  104.  
  105. def add_codec(charset, codecname):
  106.     '''Add a codec that map characters in the given charset to/from Unicode.
  107.  
  108.     charset is the canonical name of a character set.  codecname is the name
  109.     of a Python codec, as appropriate for the second argument to the unicode()
  110.     built-in, or to the encode() method of a Unicode string.
  111.     '''
  112.     CODEC_MAP[charset] = codecname
  113.  
  114.  
  115. class Charset:
  116.     """Map character sets to their email properties.
  117.  
  118.     This class provides information about the requirements imposed on email
  119.     for a specific character set.  It also provides convenience routines for
  120.     converting between character sets, given the availability of the
  121.     applicable codecs.  Given a character set, it will do its best to provide
  122.     information on how to use that character set in an email in an
  123.     RFC-compliant way.
  124.  
  125.     Certain character sets must be encoded with quoted-printable or base64
  126.     when used in email headers or bodies.  Certain character sets must be
  127.     converted outright, and are not allowed in email.  Instances of this
  128.     module expose the following information about a character set:
  129.  
  130.     input_charset: The initial character set specified.  Common aliases
  131.                    are converted to their `official' email names (e.g. latin_1
  132.                    is converted to iso-8859-1).  Defaults to 7-bit us-ascii.
  133.  
  134.     header_encoding: If the character set must be encoded before it can be
  135.                      used in an email header, this attribute will be set to
  136.                      Charset.QP (for quoted-printable), Charset.BASE64 (for
  137.                      base64 encoding), or Charset.SHORTEST for the shortest of
  138.                      QP or BASE64 encoding.  Otherwise, it will be None.
  139.  
  140.     body_encoding: Same as header_encoding, but describes the encoding for the
  141.                    mail message's body, which indeed may be different than the
  142.                    header encoding.  Charset.SHORTEST is not allowed for
  143.                    body_encoding.
  144.  
  145.     output_charset: Some character sets must be converted before the can be
  146.                     used in email headers or bodies.  If the input_charset is
  147.                     one of them, this attribute will contain the name of the
  148.                     charset output will be converted to.  Otherwise, it will
  149.                     be None.
  150.  
  151.     input_codec: The name of the Python codec used to convert the
  152.                  input_charset to Unicode.  If no conversion codec is
  153.                  necessary, this attribute will be None.
  154.  
  155.     output_codec: The name of the Python codec used to convert Unicode
  156.                   to the output_charset.  If no conversion codec is necessary,
  157.                   this attribute will have the same value as the input_codec.
  158.     """
  159.     
  160.     def __init__(self, input_charset = DEFAULT_CHARSET):
  161.         
  162.         try:
  163.             if isinstance(input_charset, unicode):
  164.                 input_charset.encode('ascii')
  165.             else:
  166.                 input_charset = unicode(input_charset, 'ascii')
  167.         except UnicodeError:
  168.             raise errors.CharsetError(input_charset)
  169.  
  170.         input_charset = input_charset.lower()
  171.         self.input_charset = ALIASES.get(input_charset, input_charset)
  172.         (henc, benc, conv) = CHARSETS.get(self.input_charset, (SHORTEST, BASE64, None))
  173.         if not conv:
  174.             conv = self.input_charset
  175.         
  176.         self.header_encoding = henc
  177.         self.body_encoding = benc
  178.         self.output_charset = ALIASES.get(conv, conv)
  179.         self.input_codec = CODEC_MAP.get(self.input_charset, self.input_charset)
  180.         self.output_codec = CODEC_MAP.get(self.output_charset, self.output_charset)
  181.  
  182.     
  183.     def __str__(self):
  184.         return self.input_charset.lower()
  185.  
  186.     __repr__ = __str__
  187.     
  188.     def __eq__(self, other):
  189.         return str(self) == str(other).lower()
  190.  
  191.     
  192.     def __ne__(self, other):
  193.         return not self.__eq__(other)
  194.  
  195.     
  196.     def get_body_encoding(self):
  197.         '''Return the content-transfer-encoding used for body encoding.
  198.  
  199.         This is either the string `quoted-printable\' or `base64\' depending on
  200.         the encoding used, or it is a function in which case you should call
  201.         the function with a single argument, the Message object being
  202.         encoded.  The function should then set the Content-Transfer-Encoding
  203.         header itself to whatever is appropriate.
  204.  
  205.         Returns "quoted-printable" if self.body_encoding is QP.
  206.         Returns "base64" if self.body_encoding is BASE64.
  207.         Returns "7bit" otherwise.
  208.         '''
  209.         if not self.body_encoding != SHORTEST:
  210.             raise AssertionError
  211.         if self.body_encoding == QP:
  212.             return 'quoted-printable'
  213.         elif self.body_encoding == BASE64:
  214.             return 'base64'
  215.         else:
  216.             return encode_7or8bit
  217.  
  218.     
  219.     def convert(self, s):
  220.         '''Convert a string from the input_codec to the output_codec.'''
  221.         if self.input_codec != self.output_codec:
  222.             return unicode(s, self.input_codec).encode(self.output_codec)
  223.         else:
  224.             return s
  225.  
  226.     
  227.     def to_splittable(self, s):
  228.         """Convert a possibly multibyte string to a safely splittable format.
  229.  
  230.         Uses the input_codec to try and convert the string to Unicode, so it
  231.         can be safely split on character boundaries (even for multibyte
  232.         characters).
  233.  
  234.         Returns the string as-is if it isn't known how to convert it to
  235.         Unicode with the input_charset.
  236.  
  237.         Characters that could not be converted to Unicode will be replaced
  238.         with the Unicode replacement character U+FFFD.
  239.         """
  240.         if isinstance(s, unicode) or self.input_codec is None:
  241.             return s
  242.         
  243.         
  244.         try:
  245.             return unicode(s, self.input_codec, 'replace')
  246.         except LookupError:
  247.             return s
  248.  
  249.  
  250.     
  251.     def from_splittable(self, ustr, to_output = True):
  252.         """Convert a splittable string back into an encoded string.
  253.  
  254.         Uses the proper codec to try and convert the string from Unicode back
  255.         into an encoded format.  Return the string as-is if it is not Unicode,
  256.         or if it could not be converted from Unicode.
  257.  
  258.         Characters that could not be converted from Unicode will be replaced
  259.         with an appropriate character (usually '?').
  260.  
  261.         If to_output is True (the default), uses output_codec to convert to an
  262.         encoded format.  If to_output is False, uses input_codec.
  263.         """
  264.         if to_output:
  265.             codec = self.output_codec
  266.         else:
  267.             codec = self.input_codec
  268.         if not isinstance(ustr, unicode) or codec is None:
  269.             return ustr
  270.         
  271.         
  272.         try:
  273.             return ustr.encode(codec, 'replace')
  274.         except LookupError:
  275.             return ustr
  276.  
  277.  
  278.     
  279.     def get_output_charset(self):
  280.         '''Return the output character set.
  281.  
  282.         This is self.output_charset if that is not None, otherwise it is
  283.         self.input_charset.
  284.         '''
  285.         if not self.output_charset:
  286.             pass
  287.         return self.input_charset
  288.  
  289.     
  290.     def encoded_header_len(self, s):
  291.         '''Return the length of the encoded header string.'''
  292.         cset = self.get_output_charset()
  293.         if self.header_encoding == BASE64:
  294.             return email.base64mime.base64_len(s) + len(cset) + MISC_LEN
  295.         elif self.header_encoding == QP:
  296.             return email.quoprimime.header_quopri_len(s) + len(cset) + MISC_LEN
  297.         elif self.header_encoding == SHORTEST:
  298.             lenb64 = email.base64mime.base64_len(s)
  299.             lenqp = email.quoprimime.header_quopri_len(s)
  300.             return min(lenb64, lenqp) + len(cset) + MISC_LEN
  301.         else:
  302.             return len(s)
  303.  
  304.     
  305.     def header_encode(self, s, convert = False):
  306.         '''Header-encode a string, optionally converting it to output_charset.
  307.  
  308.         If convert is True, the string will be converted from the input
  309.         charset to the output charset automatically.  This is not useful for
  310.         multibyte character sets, which have line length issues (multibyte
  311.         characters must be split on a character, not a byte boundary); use the
  312.         high-level Header class to deal with these issues.  convert defaults
  313.         to False.
  314.  
  315.         The type of encoding (base64 or quoted-printable) will be based on
  316.         self.header_encoding.
  317.         '''
  318.         cset = self.get_output_charset()
  319.         if convert:
  320.             s = self.convert(s)
  321.         
  322.         if self.header_encoding == BASE64:
  323.             return email.base64mime.header_encode(s, cset)
  324.         elif self.header_encoding == QP:
  325.             return email.quoprimime.header_encode(s, cset, maxlinelen = None)
  326.         elif self.header_encoding == SHORTEST:
  327.             lenb64 = email.base64mime.base64_len(s)
  328.             lenqp = email.quoprimime.header_quopri_len(s)
  329.             if lenb64 < lenqp:
  330.                 return email.base64mime.header_encode(s, cset)
  331.             else:
  332.                 return email.quoprimime.header_encode(s, cset, maxlinelen = None)
  333.         else:
  334.             return s
  335.  
  336.     
  337.     def body_encode(self, s, convert = True):
  338.         '''Body-encode a string and convert it to output_charset.
  339.  
  340.         If convert is True (the default), the string will be converted from
  341.         the input charset to output charset automatically.  Unlike
  342.         header_encode(), there are no issues with byte boundaries and
  343.         multibyte charsets in email bodies, so this is usually pretty safe.
  344.  
  345.         The type of encoding (base64 or quoted-printable) will be based on
  346.         self.body_encoding.
  347.         '''
  348.         if convert:
  349.             s = self.convert(s)
  350.         
  351.         if self.body_encoding is BASE64:
  352.             return email.base64mime.body_encode(s)
  353.         elif self.body_encoding is QP:
  354.             return email.quoprimime.body_encode(s)
  355.         else:
  356.             return s
  357.  
  358.  
  359.